API

Welcome to the future of seamless verification! Betatel’s Flash Call API empowers developers to integrate swift and secure phone number verification directly into their applications. Whether you're building a high-traffic login system or ensuring user authenticity for sensitive transactions, this API guarantees a smooth, reliable experience.

Endpoint

It all begins with the endpoint—a gateway to delivering trust.

https://api.betatel.com/api/v1/connect-hub/call/flash

Method: POST

This endpoint generates a flash call for verifying phone numbers by triggering a call with a unique caller ID.

Headers

Your ticket to authentication starts with the headers. Properly set headers are essential to ensure your request is authorized and understood.

Param	Value	Description
Content-type	application/json	Specifies the format of your payload.
x-api-key	{{x-api-key}}	Your unique API key for secure access.
x-user-id	{{x-user-id}}	Your user identifier for added security and tracking.

Request Body

The payload is the heart of your request. Here’s where you define the essence of the flash call.

Example of body

{
    "callType":"flash",
    "callee":"38764444405",
    "caller":"900111555345",
    "maxRingTime": 5
}

Field	Type	Required	Description
callType	string	Yes	Set as "flash" to specify this call type.
callee	string	Yes	The recipient’s phone number in international format.
caller	string	No	The caller ID (the number that makes the call) is used as a verification token.
maxRingTime	integer	No	Maximum duration for the call to ring, in seconds (default: 5).

Code Snippets

cUrl

Example - cURL

curl --location 'https://dev.api.betatel.com/api/v1/connect-hub/call/flash' \
--header 'x-user-id: 675aed6103dee9ca55a36a9a' \
--header 'Content-Type: application/json' \
--header 'x-api-key: ••••••' \
--data '{
    "callType":"flash",
    "callee":"38764444405",
    "caller":"900111555345",
    "maxRingTime": 5
}'

Python

Example - Python

import http.client
import json

conn = http.client.HTTPSConnection("dev.api.betatel.com")
payload = json.dumps({
  "callType": "flash",
  "callee": "38764444405",
  "caller": "900111555345",
  "maxRingTime": 5
})
headers = {
  'x-user-id': '675aed6103dee9ca55a36a9a',
  'Content-Type': 'application/json',
  'x-api-key': '••••••'
}
conn.request("POST", "/api/v1/connect-hub/call/flash", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Node.js

Example - Node.js

const axios = require('axios');
let data = JSON.stringify({
  "callType": "flash",
  "callee": "38764444405",
  "caller": "900111555345",
  "maxRingTime": 5
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://dev.api.betatel.com/api/v1/connect-hub/call/flash',
  headers: {
    'x-user-id': '675aed6103dee9ca55a36a9a',
    'Content-Type': 'application/json',
    'x-api-key': '••••••'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

PHP

Example - PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://dev.api.betatel.com/api/v1/connect-hub/call/flash',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "callType":"flash",
    "callee":"38764444405",
    "caller":"900111555345",
    "maxRingTime": 5
}',
  CURLOPT_HTTPHEADER => array(
    'x-user-id: 675aed6103dee9ca55a36a9a',
    'Content-Type: application/json',
    'x-api-key: ••••••'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

Example - Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://dev.api.betatel.com/api/v1/connect-hub/call/flash")
  .header("x-user-id", "675aed6103dee9ca55a36a9a")
  .header("Content-Type", "application/json")
  .header("x-api-key", "••••••")
  .body("{\n    \"callType\":\"flash\",\n    \"callee\":\"38764444405\",\n    \"caller\":\"900111555345\",\n    \"maxRingTime\": 5\n}")
  .asString();

C#

Example - C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://dev.api.betatel.com/api/v1/connect-hub/call/flash");
request.Headers.Add("x-user-id", "675aed6103dee9ca55a36a9a");
request.Headers.Add("x-api-key", "••••••");
var content = new StringContent("{\n    \"callType\":\"flash\",\n    \"callee\":\"38764444405\",\n    \"caller\":\"900111555345\",\n    \"maxRingTime\": 5\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

On success, the API responds with an HTTP 200 status and returns a JSON payload confirming your flash‐call request:

{
  "uuid": "01JT2R847VQC0Q2045EV7Y84XM",
  "caller": "900111555345",
  "callee": "38764444405"
}

Field Descriptions:

• uuid : A unique identifier for this flash‐call transaction. You can use it to look up call status, logs or for troubleshooting.

• caller : The phone number that was displayed as the caller ID during the flash call, even if not included in your request payload.

• callee : The phone number that received the flash call.

Congratulations

You're now equipped to implement the Flash Call API for secure and swift phone number verification. By leveraging the power of flash calls, you can deliver a seamless experience for your users, ensuring their numbers are verified in seconds.